home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet bezpieczenstwa / mini Pentoo LiveCD 2006.1 / mpentoo-2006.1.iso / livecd.squashfs / usr / lib / mozilla-firefox / idl / nsIRefreshURI.idl < prev    next >
Encoding:
Text File  |  2006-05-08  |  3.5 KB  |  85 lines
  1. /* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
  2.  *
  3.  * ***** BEGIN LICENSE BLOCK *****
  4.  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  5.  *
  6.  * The contents of this file are subject to the Mozilla Public License Version
  7.  * 1.1 (the "License"); you may not use this file except in compliance with
  8.  * the License. You may obtain a copy of the License at
  9.  * http://www.mozilla.org/MPL/
  10.  *
  11.  * Software distributed under the License is distributed on an "AS IS" basis,
  12.  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  13.  * for the specific language governing rights and limitations under the
  14.  * License.
  15.  *
  16.  * The Original Code is the Mozilla browser.
  17.  *
  18.  * The Initial Developer of the Original Code is
  19.  * Netscape Communications, Inc.
  20.  * Portions created by the Initial Developer are Copyright (C) 1999
  21.  * the Initial Developer. All Rights Reserved.
  22.  *
  23.  * Contributor(s):
  24.  *
  25.  * Alternatively, the contents of this file may be used under the terms of
  26.  * either of the GNU General Public License Version 2 or later (the "GPL"),
  27.  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28.  * in which case the provisions of the GPL or the LGPL are applicable instead
  29.  * of those above. If you wish to allow use of your version of this file only
  30.  * under the terms of either the GPL or the LGPL, and not to allow others to
  31.  * use your version of this file under the terms of the MPL, indicate your
  32.  * decision by deleting the provisions above and replace them with the notice
  33.  * and other provisions required by the GPL or the LGPL. If you do not delete
  34.  * the provisions above, a recipient may use your version of this file under
  35.  * the terms of any one of the MPL, the GPL or the LGPL.
  36.  *
  37.  * ***** END LICENSE BLOCK ***** */
  38.  
  39. #include "nsISupports.idl"
  40. #include "nsIURI.idl"
  41. interface nsIChannel;
  42.  
  43. [scriptable, uuid(69EFC430-2EFE-11d2-9E5D-006008BF092E)]
  44. interface nsIRefreshURI : nsISupports {
  45.     /**
  46.       * Load a uri after waiting for aMillis milliseconds. If the docshell
  47.       * is busy loading a page currently, the refresh request will be
  48.       * queued and executed when the current load finishes. 
  49.       *
  50.       * @param aUri The uri to refresh.
  51.       * @param aMillis The number of milliseconds to wait.
  52.       * @param aRepeat Flag to indicate if the uri is to be 
  53.       *                repeatedly refreshed every aMillis milliseconds.
  54.       * @parem aMetaRefresh Flag to indicate if this is a Meta refresh.
  55.       */
  56.     void refreshURI(in nsIURI aURI, in long aMillis, in boolean aRepeat, in boolean aMetaRefresh);
  57.  
  58.     /**
  59.       * Checks the passed in channel to see if there is a refresh header, 
  60.       * if there is, will setup a timer to refresh the uri found
  61.       * in the header. If docshell is busy loading a page currently, the
  62.       * request will be queued and executed when the current page 
  63.       * finishes loading. 
  64.       *
  65.       * @param aChannel The channel to be parsed. 
  66.       */
  67.     void setupRefreshURI(in nsIChannel aChannel); 
  68.  
  69.     /**
  70.       * Parses the passed in header string and sets up a refreshURI if
  71.       * a "refresh" header is found. If docshell is busy loading a page 
  72.       * currently, the request will be queued and executed when 
  73.       * the current page finishes loading. 
  74.       *
  75.       * @param aBaseURI base URI to resolve refresh uri with.
  76.       * @param aHeader  The meta refresh header string.
  77.       */
  78.     void setupRefreshURIFromHeader(in nsIURI aBaseURI, in ACString aHeader);
  79.       
  80.     /**
  81.       * Cancels all timer loads.
  82.       */
  83.     void cancelRefreshURITimers();
  84. };
  85.